fix(removeComments): make preserving comments a param #1812
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
SethFalco
force-pushed
the
fix/remove-comments
branch
4 times, most recently
from
c0064d4
to
d09612d
Compare
SethFalco
commented
Oct 22, 2023
SethFalco
changed the title
SethFalco
force-pushed
the
fix/remove-comments
branch
from
d09612d
to
fe0dc98
Compare
nono
referenced
this pull request
in cozy/cozy-stack
Nov 13, 2023
[](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [svgo](https://svgo.dev) ([source](https://togithub.com/svg/svgo)) | [`3.0.2` -> `3.0.3`](https://renovatebot.com/diffs/npm/svgo/3.0.2/3.0.3) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>svg/svgo (svgo)</summary> ### [`v3.0.3`](https://togithub.com/svg/svgo/releases/tag/v3.0.3) [Compare Source](https://togithub.com/svg/svgo/compare/v3.0.2...v3.0.3) Includes various bug fixes and optimizations for existing plugins. We're also revamped the documentation for the project. You can find it on [svgo.dev](https://svgo.dev/)! The frontend for svgo.dev is maintained in [svg/svgo.dev](https://togithub.com/svg/svgo.dev), contributions are welcome. #### What's Changed ##### Settings - **Remove Comments**, introduces `preservePatterns` parameter. Preserves legal comments by default, same as the previous behavior, but can now be overridden. By [@​SethFalco](https://togithub.com/SethFalco) in [https://github.com/svg/svgo/pull/1812](https://togithub.com/svg/svgo/pull/1812) - **Remove Description**, set the `removeAny` parameter to `false` by default for accessibility. By [@​SethFalco](https://togithub.com/SethFalco) in [https://github.com/svg/svgo/pull/1806](https://togithub.com/svg/svgo/pull/1806) ##### Bug Fixes - **Remove Raster Images**, removes inlined JPEG images. By [@​abejfehr](https://togithub.com/abejfehr) in [https://github.com/svg/svgo/pull/1742](https://togithub.com/svg/svgo/pull/1742) - **Cleanup IDs**, correctly handle when 2 IDs have been referenced in a single attribute. By [@​SethFalco](https://togithub.com/SethFalco) in [https://github.com/svg/svgo/pull/1795](https://togithub.com/svg/svgo/pull/1795) - **Cleanup IDS**, correctly handle when we've encountered a reference to a node that doesn't exist. By [@​SethFalco](https://togithub.com/SethFalco) in [https://github.com/svg/svgo/pull/1817](https://togithub.com/svg/svgo/pull/1817) - **Inline Styles**, treat style prop keys as case-insensitive. By [@​SethFalco](https://togithub.com/SethFalco) in [https://github.com/svg/svgo/pull/1797](https://togithub.com/svg/svgo/pull/1797) - **Inline Styles**, remove all classes in multiclass selector. By [@​SethFalco](https://togithub.com/SethFalco) in [https://github.com/svg/svgo/pull/1801](https://togithub.com/svg/svgo/pull/1801) - **Inline Styles**, ignore empty CSS blocks instead of adding empty style attribute. By [@​SethFalco](https://togithub.com/SethFalco) in [https://github.com/svg/svgo/pull/1823](https://togithub.com/svg/svgo/pull/1823) - **Minify Styles**, removes unused class selectors when the document has no classes. By [@​SethFalco](https://togithub.com/SethFalco) in [https://github.com/svg/svgo/pull/1800](https://togithub.com/svg/svgo/pull/1800) - **Prefix IDs**, reuse the same prefix when encountering an ID multiple times. By [@​SethFalco](https://togithub.com/SethFalco) in [https://github.com/svg/svgo/pull/1814](https://togithub.com/svg/svgo/pull/1814) - **Remove Hidden Elements**, stops removing non-rendering elements like masks. By [@​SethFalco](https://togithub.com/SethFalco) in [https://github.com/svg/svgo/pull/1793](https://togithub.com/svg/svgo/pull/1793) - **Reuse Paths**, creates a new ID if the current one is referenced by another element. By [@​SethFalco](https://togithub.com/SethFalco) in [https://github.com/svg/svgo/pull/1784](https://togithub.com/svg/svgo/pull/1784) - **Reuse Paths**, removes redundant `defs` children after optimization. By [@​SethFalco](https://togithub.com/SethFalco) in [https://github.com/svg/svgo/pull/1785](https://togithub.com/svg/svgo/pull/1785) - **Reuse Paths**, stops duplicating attributes into the shared definition. By [@​SethFalco](https://togithub.com/SethFalco) in [https://github.com/svg/svgo/pull/1791](https://togithub.com/svg/svgo/pull/1791) - Don't crash on a `null`, `undefined`, or empty plugin. Instead, log a warning and ignore it. By [@​SethFalco](https://togithub.com/SethFalco) in [https://github.com/svg/svgo/issues/1128](https://togithub.com/svg/svgo/issues/1128) ##### SVG Optimization - **Convert Transform**, omit spaces between functions. By [@​SethFalco](https://togithub.com/SethFalco) in [https://github.com/svg/svgo/pull/1802](https://togithub.com/svg/svgo/pull/1802) - **Remove Scripts**, removes callbacks (`on*`) and `href` attributes with `javascript:` URIs. By [@​cakeinpanic](https://togithub.com/cakeinpanic) and [@​SethFalco](https://togithub.com/SethFalco) in [https://github.com/svg/svgo/pull/1807](https://togithub.com/svg/svgo/pull/1807), [https://github.com/svg/svgo/pull/1818](https://togithub.com/svg/svgo/pull/1818), [https://github.com/svg/svgo/pull/1819](https://togithub.com/svg/svgo/pull/1819), [https://github.com/svg/svgo/pull/1820](https://togithub.com/svg/svgo/pull/1820) - **Convert One-Stop Gradients**, new plugin to convert gradients with one stop to a solid color, disabled by default. By [@​SethFalco](https://togithub.com/SethFalco) in [https://github.com/svg/svgo/pull/1790](https://togithub.com/svg/svgo/pull/1790) ##### Performance - Various optimizations for path handling. By [@​marvinhagemeister](https://togithub.com/marvinhagemeister) in [https://github.com/svg/svgo/pull/1716](https://togithub.com/svg/svgo/pull/1716) and [https://github.com/svg/svgo/pull/1717](https://togithub.com/svg/svgo/pull/1717) ##### Chores - Revise the README. By [@​ADTC](https://togithub.com/ADTC) in [https://github.com/svg/svgo/pull/1731](https://togithub.com/svg/svgo/pull/1731) - Fix dead link to postcss-svgo in README. By [@​Lehoczky](https://togithub.com/Lehoczky) in [https://github.com/svg/svgo/pull/1770](https://togithub.com/svg/svgo/pull/1770) - Replace webpack loader library in README as previous was deprecated. By [@​tanyabouman](https://togithub.com/tanyabouman) in [https://github.com/svg/svgo/pull/1771](https://togithub.com/svg/svgo/pull/1771) #### Metrics Before and after using vectors from various sources, with the default preset of each respective version: | SVG | Original | v3.0.2 | v3.0.3 | Delta | |---|---|---|---|---| | [Arch Linux Logo](https://archlinux.org/art/) | 8.584 KiB | 4.748 KiB | 4.747 KiB | ⬇️ 0.001 KiB | | [Blobs](https://gitlab.gnome.org/GNOME/gnome-backgrounds/-/blob/main/backgrounds/blobs-d.svg) | 50.45 KiB | 42.949 KiB | 42.949 KiB | | | [Isometric Madness](https://inkscape.org/~Denis_Kuznetsky/%E2%98%85isometric-madness) | 869.034 KiB | 550.829 KiB | 550.699 KiB | ⬇️ 0.13 KiB | | [tldr-pages Banner](https://togithub.com/tldr-pages/tldr/blob/main/images/banner.svg) | 2.071 KiB | 1.07 KiB | 1.07 KiB | | | [Wikipedia Logo](https://en.wikipedia.org/wiki/File:Wikipedia-logo-v2.svg) | 161.552 KiB | 118.441 KiB | 118.441 KiB | | Before and after of the browser bundle of each respective version: | | v3.0.2 | v3.0.3 | Delta | |---|---|---|---| | svgo.browser.js | 643.5 kB | 651.7 kB | ⬆️ 8.2 kB | </details> --- ### Configuration 📅 **Schedule**: Branch creation - "before 6am on Monday" in timezone Europe/Paris, Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/cozy/cozy-stack). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy40Ni4wIiwidXBkYXRlZEluVmVyIjoiMzcuNDYuMCIsInRhcmdldEJyYW5jaCI6Im1hc3RlciJ9-->
sungik-choi
referenced
this pull request
in channel-io/bezier-react
Nov 16, 2023
[](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [svgo](https://svgo.dev) ([source](https://togithub.com/svg/svgo)) | [`3.0.2` -> `3.0.3`](https://renovatebot.com/diffs/npm/svgo/3.0.2/3.0.3) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>svg/svgo (svgo)</summary> ### [`v3.0.3`](https://togithub.com/svg/svgo/releases/tag/v3.0.3) [Compare Source](https://togithub.com/svg/svgo/compare/v3.0.2...v3.0.3) Includes various bug fixes and optimizations for existing plugins. We're also revamped the documentation for the project. You can find it on [svgo.dev](https://svgo.dev/)! The frontend for svgo.dev is maintained in [svg/svgo.dev](https://togithub.com/svg/svgo.dev), contributions are welcome. #### What's Changed ##### Settings - **Remove Comments**, introduces `preservePatterns` parameter. Preserves legal comments by default, same as the previous behavior, but can now be overridden. By [@​SethFalco](https://togithub.com/SethFalco) in [https://github.com/svg/svgo/pull/1812](https://togithub.com/svg/svgo/pull/1812) - **Remove Description**, set the `removeAny` parameter to `false` by default for accessibility. By [@​SethFalco](https://togithub.com/SethFalco) in [https://github.com/svg/svgo/pull/1806](https://togithub.com/svg/svgo/pull/1806) ##### Bug Fixes - **Remove Raster Images**, removes inlined JPEG images. By [@​abejfehr](https://togithub.com/abejfehr) in [https://github.com/svg/svgo/pull/1742](https://togithub.com/svg/svgo/pull/1742) - **Cleanup IDs**, correctly handle when 2 IDs have been referenced in a single attribute. By [@​SethFalco](https://togithub.com/SethFalco) in [https://github.com/svg/svgo/pull/1795](https://togithub.com/svg/svgo/pull/1795) - **Cleanup IDS**, correctly handle when we've encountered a reference to a node that doesn't exist. By [@​SethFalco](https://togithub.com/SethFalco) in [https://github.com/svg/svgo/pull/1817](https://togithub.com/svg/svgo/pull/1817) - **Inline Styles**, treat style prop keys as case-insensitive. By [@​SethFalco](https://togithub.com/SethFalco) in [https://github.com/svg/svgo/pull/1797](https://togithub.com/svg/svgo/pull/1797) - **Inline Styles**, remove all classes in multiclass selector. By [@​SethFalco](https://togithub.com/SethFalco) in [https://github.com/svg/svgo/pull/1801](https://togithub.com/svg/svgo/pull/1801) - **Inline Styles**, ignore empty CSS blocks instead of adding empty style attribute. By [@​SethFalco](https://togithub.com/SethFalco) in [https://github.com/svg/svgo/pull/1823](https://togithub.com/svg/svgo/pull/1823) - **Minify Styles**, removes unused class selectors when the document has no classes. By [@​SethFalco](https://togithub.com/SethFalco) in [https://github.com/svg/svgo/pull/1800](https://togithub.com/svg/svgo/pull/1800) - **Prefix IDs**, reuse the same prefix when encountering an ID multiple times. By [@​SethFalco](https://togithub.com/SethFalco) in [https://github.com/svg/svgo/pull/1814](https://togithub.com/svg/svgo/pull/1814) - **Remove Hidden Elements**, stops removing non-rendering elements like masks. By [@​SethFalco](https://togithub.com/SethFalco) in [https://github.com/svg/svgo/pull/1793](https://togithub.com/svg/svgo/pull/1793) - **Reuse Paths**, creates a new ID if the current one is referenced by another element. By [@​SethFalco](https://togithub.com/SethFalco) in [https://github.com/svg/svgo/pull/1784](https://togithub.com/svg/svgo/pull/1784) - **Reuse Paths**, removes redundant `defs` children after optimization. By [@​SethFalco](https://togithub.com/SethFalco) in [https://github.com/svg/svgo/pull/1785](https://togithub.com/svg/svgo/pull/1785) - **Reuse Paths**, stops duplicating attributes into the shared definition. By [@​SethFalco](https://togithub.com/SethFalco) in [https://github.com/svg/svgo/pull/1791](https://togithub.com/svg/svgo/pull/1791) - Don't crash on a `null`, `undefined`, or empty plugin. Instead, log a warning and ignore it. By [@​SethFalco](https://togithub.com/SethFalco) in [https://github.com/svg/svgo/issues/1128](https://togithub.com/svg/svgo/issues/1128) ##### SVG Optimization - **Convert Transform**, omit spaces between functions. By [@​SethFalco](https://togithub.com/SethFalco) in [https://github.com/svg/svgo/pull/1802](https://togithub.com/svg/svgo/pull/1802) - **Remove Scripts**, removes callbacks (`on*`) and `href` attributes with `javascript:` URIs. By [@​cakeinpanic](https://togithub.com/cakeinpanic) and [@​SethFalco](https://togithub.com/SethFalco) in [https://github.com/svg/svgo/pull/1807](https://togithub.com/svg/svgo/pull/1807), [https://github.com/svg/svgo/pull/1818](https://togithub.com/svg/svgo/pull/1818), [https://github.com/svg/svgo/pull/1819](https://togithub.com/svg/svgo/pull/1819), [https://github.com/svg/svgo/pull/1820](https://togithub.com/svg/svgo/pull/1820) - **Convert One-Stop Gradients**, new plugin to convert gradients with one stop to a solid color, disabled by default. By [@​SethFalco](https://togithub.com/SethFalco) in [https://github.com/svg/svgo/pull/1790](https://togithub.com/svg/svgo/pull/1790) ##### Performance - Various optimizations for path handling. By [@​marvinhagemeister](https://togithub.com/marvinhagemeister) in [https://github.com/svg/svgo/pull/1716](https://togithub.com/svg/svgo/pull/1716) and [https://github.com/svg/svgo/pull/1717](https://togithub.com/svg/svgo/pull/1717) ##### Chores - Revise the README. By [@​ADTC](https://togithub.com/ADTC) in [https://github.com/svg/svgo/pull/1731](https://togithub.com/svg/svgo/pull/1731) - Fix dead link to postcss-svgo in README. By [@​Lehoczky](https://togithub.com/Lehoczky) in [https://github.com/svg/svgo/pull/1770](https://togithub.com/svg/svgo/pull/1770) - Replace webpack loader library in README as previous was deprecated. By [@​tanyabouman](https://togithub.com/tanyabouman) in [https://github.com/svg/svgo/pull/1771](https://togithub.com/svg/svgo/pull/1771) #### Metrics Before and after using vectors from various sources, with the default preset of each respective version: | SVG | Original | v3.0.2 | v3.0.3 | Delta | |---|---|---|---|---| | [Arch Linux Logo](https://archlinux.org/art/) | 8.584 KiB | 4.748 KiB | 4.747 KiB | ⬇️ 0.001 KiB | | [Blobs](https://gitlab.gnome.org/GNOME/gnome-backgrounds/-/blob/main/backgrounds/blobs-d.svg) | 50.45 KiB | 42.949 KiB | 42.949 KiB | | | [Isometric Madness](https://inkscape.org/~Denis_Kuznetsky/%E2%98%85isometric-madness) | 869.034 KiB | 550.829 KiB | 550.699 KiB | ⬇️ 0.13 KiB | | [tldr-pages Banner](https://togithub.com/tldr-pages/tldr/blob/main/images/banner.svg) | 2.071 KiB | 1.07 KiB | 1.07 KiB | | | [Wikipedia Logo](https://en.wikipedia.org/wiki/File:Wikipedia-logo-v2.svg) | 161.552 KiB | 118.441 KiB | 118.441 KiB | | Before and after of the browser bundle of each respective version: | | v3.0.2 | v3.0.3 | Delta | |---|---|---|---| | svgo.browser.js | 643.5 kB | 651.7 kB | ⬆️ 8.2 kB | </details> --- ### Configuration 📅 **Schedule**: Branch creation - "on Monday after 10am before 7pm" in timezone Asia/Seoul, Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/channel-io/bezier-react). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy40Ni4wIiwidXBkYXRlZEluVmVyIjoiMzcuNDYuMCIsInRhcmdldEJyYW5jaCI6Im1haW4ifQ==--> --------- Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: Ed Sungik Choi <[email protected]>
](https://renovatebot.com){kind=link}
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Converts the hard-coded exception to a param so users can override this behavior to preserve custom patterns or drop the logic altogether.
We retain the existing exception as the default value, as this convention is interpreted across minifiers as important. For example, Font Awesome prefixes their comment with a
!.However, we also allow users to pass custom patterns, or either
preservePatterns: []orpreservePatterns: falseto indiscriminately remove comments.This is completely backward compatible.
I also replaced the
ignored commentin the tests with something that matches the kind of comment we're expecting to encounter with this prefix.Related